﻿/*******************************************************************************************
 * Copyright (c) 2006-2009 Alex Robson, Rob Simmons, Craig Israel, and Rachel Twyford
 *
 * Use of this software in any form requires that you have both 
 * read and agreed to the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions: 
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the 
 * documentation and/or other materials provided with the distribution.
 * Neither the name of Nvigorate nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ****************************************************************************************/

using System.Collections.Generic;
using Nvigorate.Xml;

namespace Nvigorate.Relational.Mapping.Interface
{
    /// <summary>
    /// This interface describes the necessary information which is required by the IBinder interface
    /// in order to bind data from one source to another.
    /// </summary>
    public interface ISourceMap : ILinqToXml
    {
        /// <summary>
        /// The collection of assignments which describe the bindings
        /// and how each one works
        /// </summary>
        List<IAssignment> Assignments
        { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the delete operation is available 
        /// for the mapped type.
        /// </summary>
        /// <value>
        /// 	<c>true</c> if this instance can delete; otherwise, <c>false</c>.
        /// </value>
        bool CanDelete
        { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether insert operation is available 
        /// for the mapped type.
        /// </summary>
        /// <value>
        /// 	<c>true</c> if this instance can insert; otherwise, <c>false</c>.
        /// </value>
        bool CanInsert
        { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the select operation is available 
        /// for the mapped type.
        /// </summary>
        /// <value>
        /// 	<c>true</c> if this instance can select; otherwise, <c>false</c>.
        /// </value>
        bool CanSelect
        { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the update operation is available 
        /// for the mapped type.
        /// </summary>
        /// <value>
        /// 	<c>true</c> if this instance can update; otherwise, <c>false</c>.
        /// </value>
        bool CanUpdate
        { get; set; }

        /// <summary>
        /// If set, specificies the order in which persistence to sources should take place
        /// </summary>
        int CreateOrder
        { get; set; }

        /// <summary>
        /// Determines how, if at all, this source joins to the others in the binding map
        /// </summary>
        IJoin Join { get; set; }

        /// <summary>
        /// The name of the source entity
        /// </summary>
        string SourceName
        { get; set; }

        /// <summary>
        /// The type of source represented by the Source Map
        /// </summary>
        SourceMapType SourceType
        {
            get; set;
        }

        bool TargetRequiresConstructor
        {
            get; set;
        }
    }
}